Skip to content

Add kode dot board variant #11370

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 4 commits into from
Closed

Add kode dot board variant #11370

wants to merge 4 commits into from

Conversation

LusimiCollado
Copy link

Description of Change

This PR adds full support for the KodeDot ESP32-S3R8 board variant to the Arduino-ESP32 core:

  • New variant directory variants/kodedot/ containing:
    • pins_arduino.h with pin mappings for the 2×10 header, QSPI-LCD, SD, I²C buses, buttons, NeoPixel, JTAG, USB power pins, etc.
    • kodedot_partitions.csv defining the custom flash layout (OTA, SPIFFS, app slots).
    • custom_ota_override.cpp to override the weak verifyRollbackLater() hook, forcing OTA images to remain un-validated until explicitly approved, thus protecting against faulty updates.
  • Platform configuration in platform.txt:
    • Custom upload tool esptool_py_nomerge that writes firmware at the partition offset defined in kodedot_partitions.csv without manual flags.
  • Documentation updated in:
    • boards.txt (board entry for kode dot)
    • platform.txt (custom tool declaration)

With these additions, users can select kode dot, compile and upload their sketch (or OTA) directly into the correct partition, and rely on the custom_ota_override.cpp behavior to guard against bad firmware rolls.

Test scenarios

I have tested and debugged this PR on real KodeDot ESP32-S3R8 hardware using:

  • Arduino-ESP32 core v3.2.0
  • macOS 14.5 with Arduino IDE 2.3.2 (custom tool)
  • Examples run:
    • Blink / NeoPixel (LED_BUILTIN)
    • I²C scan (external header & internal sensor bus)
    • SPI to micro-SD (SPI2_HOST)
    • QSPI-LCD fill screen @40 MHz (SPI3_HOST)
    • Firmware upload lands at correct offset via esptool_py_nomerge
    • USB-Serial enumeration (VID/PID 0x303A:0x1001)
    • Button presses & JTAG debug
    • OTA update behavior: new images remain un-validated until manual confirmation, and rollback works as intended.

All tests passed, including OTA rollback verification.

Related links

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ LusimiCollado
❌ Luis Miguel Collado Llera

Luis Miguel Collado Llera seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions GitHub Actions
Copy link
Contributor

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "kode dot board added":
    • summary looks empty
    • type/action looks empty
  • the commit message "kode dot board added":
    • summary looks empty
    • type/action looks empty
  • the commit message "kode dot board with pins defined":
    • summary looks empty
    • type/action looks empty

Please fix these commit messages - here are some basic tips:

  • follow Conventional Commits style
  • correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue
  • allowed types are: change,ci,docs,feat,fix,refactor,remove,revert,test
  • sufficiently descriptive message summary should be between 10 to 72 characters and start with upper case letter
  • avoid Jira references in commit messages (unavailable/irrelevant for our customers)

TIP: Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).

👋 Hello LusimiCollado, we appreciate your contribution to this project!

📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.
🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project.
Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against a501b4d

@LusimiCollado
Copy link
Author

Changes needed from developer side

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@LusimiCollado @CLAassistant